/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.hadoop.yarn.server.timelineservice.documentstore.reader;

import org.apache.hadoop.yarn.server.timelineservice.reader.TimelineReaderContext;
import org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.NoDocumentFoundException;
import org.apache.hadoop.yarn.server.timelineservice.documentstore.collection.document.TimelineDocument;
import org.apache.hadoop.yarn.server.timelineservice.documentstore.lib.DocumentStoreVendor;

import java.util.List;
import java.util.Set;

/**
 * Every {@link DocumentStoreVendor} have to implement this for creating
 * reader to its backend.
 */
public interface DocumentStoreReader<Document extends TimelineDocument>
    extends AutoCloseable {

  Document readDocument(String collectionName, TimelineReaderContext context,
      Class<Document> documentClass) throws NoDocumentFoundException;

  List<Document> readDocumentList(String collectionName,
      TimelineReaderContext context, Class<Document> documentClass,
      long documentsSize) throws NoDocumentFoundException;

  Set<String> fetchEntityTypes(String collectionName,
      TimelineReaderContext context);
}